Added Description and License sections to Readme + Documented backend functions #72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kthchew
suggested changes
Nov 8, 2023
| @@ -65,4 +92,205 @@ | |||
| - [Expo Documentation](https://docs.expo.dev/) | |||
| - [Golang Documentation](https://go.dev/doc/) | |||
|
|
|||
|
|
|||
| ## License | |||
There was a problem hiding this comment.
probably best to put in a separate LICENSE or COPYING file instead of the README.md (if you want a mention of Apache in the README that's probably fine), I'm not sure if GitHub will auto detect the license if it's not (and it's a lot of stuff in the README that most people won't read)
Also, just curious, why Apache? Most of the other OSC projects seem to be MIT, but some are AGPL or GPL. I don't have a strong preference either way but was just wondering
Comment on lines
+5
to
+12
| 1[Description](#description) | ||
| 2[Install](#install) | ||
| 3[Usage](#usage) | ||
| 4[Debugging](#debugging) | ||
| 5[Contributing](#contributing) | ||
| - [Front End](#front-end) | ||
| - [Tips](#tips) | ||
| 6[License](#license) |
There was a problem hiding this comment.
Is this change to the list intentional? Doesn't look as nice of a list to me imo
| result, err := database.Execute("INSERT INTO Accounts (email, password) VALUES (?, SHA2(?, 256))", acc.Email, acc.Password) | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| // Check if any rows were affected by the database operation. |
There was a problem hiding this comment.
If you want to comment this it's probably more effective to say that no rows affected = account already exists (iirc)
Comment on lines
+20
to
+36
| Key Features: | ||
| Discover Lunch Partners: Browse through profiles of fellow students from various fields of study and interests. | ||
| Schedule Lunches: Arrange meetups at your convenience, allowing you to make the most of your break time. | ||
| Expand Your Network: Connect with individuals in your field of study, fostering opportunities for future collaborations and mentorships. | ||
| Enhanced Social Experience: Share your interests, hobbies, and career aspirations to find like-minded individuals. | ||
| Safe and Secure: Your privacy and safety are our top priorities. Enjoy a secure environment for making connections. | ||
| How It Works: | ||
| Create Your Profile: Sign up and build a personal profile highlighting your interests, major, and availability. | ||
| Find Lunch Partners: Browse profiles and connect with students who share your interests or career goals. | ||
| Schedule a Lunch: Propose meetups and set the date, time, and location for your lunch get-togethers. | ||
| Meet and Connect: Enjoy meaningful conversations and make lasting connections with your lunch buddies. | ||
| Why Lunch Buddies? | ||
| Networking Opportunities: Expand your network and gain insights into your chosen field of study or career path. | ||
| Friendship Building: Forge friendships that extend beyond your lunch meetups. | ||
| Campus Community: Strengthen the sense of community among your fellow students. | ||
| Personal Growth: Step out of your comfort zone and enhance your social skills. | ||
| Join Lunch Buddies today and start building connections, one meal at a time. Whether you're an undergraduate, graduate student, or simply hungry for friendship, we're here to help you find your lunchtime companions. |
There was a problem hiding this comment.
Suggested change
| Key Features: | |
| Discover Lunch Partners: Browse through profiles of fellow students from various fields of study and interests. | |
| Schedule Lunches: Arrange meetups at your convenience, allowing you to make the most of your break time. | |
| Expand Your Network: Connect with individuals in your field of study, fostering opportunities for future collaborations and mentorships. | |
| Enhanced Social Experience: Share your interests, hobbies, and career aspirations to find like-minded individuals. | |
| Safe and Secure: Your privacy and safety are our top priorities. Enjoy a secure environment for making connections. | |
| How It Works: | |
| Create Your Profile: Sign up and build a personal profile highlighting your interests, major, and availability. | |
| Find Lunch Partners: Browse profiles and connect with students who share your interests or career goals. | |
| Schedule a Lunch: Propose meetups and set the date, time, and location for your lunch get-togethers. | |
| Meet and Connect: Enjoy meaningful conversations and make lasting connections with your lunch buddies. | |
| Why Lunch Buddies? | |
| Networking Opportunities: Expand your network and gain insights into your chosen field of study or career path. | |
| Friendship Building: Forge friendships that extend beyond your lunch meetups. | |
| Campus Community: Strengthen the sense of community among your fellow students. | |
| Personal Growth: Step out of your comfort zone and enhance your social skills. | |
| Join Lunch Buddies today and start building connections, one meal at a time. Whether you're an undergraduate, graduate student, or simply hungry for friendship, we're here to help you find your lunchtime companions. | |
| ### Key Features | |
| - Discover Lunch Partners: Browse through profiles of fellow students from various fields of study and interests. | |
| - Schedule Lunches: Arrange meetups at your convenience, allowing you to make the most of your break time. | |
| - Expand Your Network: Connect with individuals in your field of study, fostering opportunities for future collaborations and mentorships. | |
| - Enhanced Social Experience: Share your interests, hobbies, and career aspirations to find like-minded individuals. | |
| - Safe and Secure: Your privacy and safety are our top priorities. Enjoy a secure environment for making connections. | |
| ### How It Works | |
| 1. Create Your Profile: Sign up and build a personal profile highlighting your interests, major, and availability. | |
| 2. Find Lunch Partners: Browse profiles and connect with students who share your interests or career goals. | |
| 3. Schedule a Lunch: Propose meetups and set the date, time, and location for your lunch get-togethers. | |
| 4. Meet and Connect: Enjoy meaningful conversations and make lasting connections with your lunch buddies. | |
| ### Why Lunch Buddies? | |
| - Networking Opportunities: Expand your network and gain insights into your chosen field of study or career path. | |
| - Friendship Building: Forge friendships that extend beyond your lunch meetups. | |
| - Campus Community: Strengthen the sense of community among your fellow students. | |
| - Personal Growth: Step out of your comfort zone and enhance your social skills. | |
| Join Lunch Buddies today and start building connections, one meal at a time. Whether you're an undergraduate, graduate student, or simply hungry for friendship, we're here to help you find your lunchtime companions. |
An empty line is needed between each line, otherwise GitHub's Markdown viewer will show this entire block as one big paragraph with no line breaks
Or a bulleted list could be used with no empty lines
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Missing clear goals and descriptions of the app. Functions could include more comments to make revisions easier for first timers.
Description
Added a description to readme.md that explicitly states what the app wants to achieve. Includes goals, motivations, and ways to expand app functionality. Added a possible Apache license that can be used to clearly state the fair usage of the software. Added comments for backend functions that are confusing at first, especially for developers unfamiliar with Golang.
Type Of Change
Checklist